Skip to content

Commit

Permalink
chore: remove all @experimental annotation (aws#14071)
Browse files Browse the repository at this point in the history
As a part of v2 efforts we are stabilizing all `@experimental` APIs from stable modules.  A separate PR aws#14070, adds a lint rule that ban the usage of @experimental.

#### Note on experimental modules
The removal of the @experimental annotation from APIs in experimental modules does not change their stability, as it determined only by their containing module stability.  

----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
NetaNir authored and john-tipper committed May 10, 2021
1 parent 8f8cc7b commit 612f55b
Show file tree
Hide file tree
Showing 82 changed files with 61 additions and 308 deletions.
8 changes: 0 additions & 8 deletions packages/@aws-cdk/aws-apigateway/lib/api-definition.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,10 @@ import { Construct } from '@aws-cdk/core';

/**
* Represents an OpenAPI definition asset.
* @experimental
*/
export abstract class ApiDefinition {
/**
* Creates an API definition from a specification file in an S3 bucket
* @experimental
*/
public static fromBucket(bucket: s3.IBucket, key: string, objectVersion?: string): S3ApiDefinition {
return new S3ApiDefinition(bucket, key, objectVersion);
Expand Down Expand Up @@ -70,7 +68,6 @@ export abstract class ApiDefinition {

/**
* Loads the API specification from a local disk asset.
* @experimental
*/
public static fromAsset(file: string, options?: s3_assets.AssetOptions): AssetApiDefinition {
return new AssetApiDefinition(file, options);
Expand All @@ -88,7 +85,6 @@ export abstract class ApiDefinition {

/**
* S3 location of the API definition file
* @experimental
*/
export interface ApiDefinitionS3Location {
/** The S3 bucket */
Expand All @@ -104,7 +100,6 @@ export interface ApiDefinitionS3Location {

/**
* Post-Binding Configuration for a CDK construct
* @experimental
*/
export interface ApiDefinitionConfig {
/**
Expand All @@ -124,7 +119,6 @@ export interface ApiDefinitionConfig {

/**
* OpenAPI specification from an S3 archive.
* @experimental
*/
export class S3ApiDefinition extends ApiDefinition {
private bucketName: string;
Expand Down Expand Up @@ -152,7 +146,6 @@ export class S3ApiDefinition extends ApiDefinition {

/**
* OpenAPI specification from an inline JSON object.
* @experimental
*/
export class InlineApiDefinition extends ApiDefinition {
constructor(private definition: any) {
Expand All @@ -176,7 +169,6 @@ export class InlineApiDefinition extends ApiDefinition {

/**
* OpenAPI specification from a local file.
* @experimental
*/
export class AssetApiDefinition extends ApiDefinition {
private asset?: s3_assets.Asset;
Expand Down
11 changes: 0 additions & 11 deletions packages/@aws-cdk/aws-apigateway/lib/apigatewayv2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,6 @@ export class CfnApiV2 extends cdk.CfnResource implements cdk.IInspectable {
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnApiV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -637,7 +636,6 @@ export class CfnApiMappingV2 extends cdk.CfnResource implements cdk.IInspectable
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnApiMappingV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -869,7 +867,6 @@ export class CfnAuthorizerV2 extends cdk.CfnResource implements cdk.IInspectable
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnAuthorizerV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -1065,7 +1062,6 @@ export class CfnDeploymentV2 extends cdk.CfnResource implements cdk.IInspectable
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnDeploymentV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -1212,7 +1208,6 @@ export class CfnDomainNameV2 extends cdk.CfnResource implements cdk.IInspectable
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnDomainNameV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -1576,7 +1571,6 @@ export class CfnIntegrationV2 extends cdk.CfnResource implements cdk.IInspectabl
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnIntegrationV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -1786,7 +1780,6 @@ export class CfnIntegrationResponseV2 extends cdk.CfnResource implements cdk.IIn
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnIntegrationResponseV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -1959,7 +1952,6 @@ export class CfnModelV2 extends cdk.CfnResource implements cdk.IInspectable {
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnModelV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -2233,7 +2225,6 @@ export class CfnRouteV2 extends cdk.CfnResource implements cdk.IInspectable {
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnRouteV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -2475,7 +2466,6 @@ export class CfnRouteResponseV2 extends cdk.CfnResource implements cdk.IInspecta
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnRouteResponseV2.CFN_RESOURCE_TYPE_NAME);
Expand Down Expand Up @@ -2784,7 +2774,6 @@ export class CfnStageV2 extends cdk.CfnResource implements cdk.IInspectable {
*
* @param inspector - tree inspector to collect and process attributes
*
* @stability experimental
*/
public inspect(inspector: cdk.TreeInspector) {
inspector.addAttribute('aws:cdk:cloudformation:type', CfnStageV2.CFN_RESOURCE_TYPE_NAME);
Expand Down
3 changes: 0 additions & 3 deletions packages/@aws-cdk/aws-apigateway/lib/restapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,6 @@ export interface RestApiProps extends RestApiOptions {

/**
* Props to instantiate a new SpecRestApi
* @experimental
*/
export interface SpecRestApiProps extends RestApiBaseProps {
/**
Expand Down Expand Up @@ -587,7 +586,6 @@ export abstract class RestApiBase extends Resource implements IRestApi {
* By default, the API will automatically be deployed and accessible from a
* public endpoint.
*
* @experimental
*
* @resource AWS::ApiGateway::RestApi
*/
Expand Down Expand Up @@ -680,7 +678,6 @@ export class RestApi extends RestApiBase {

/**
* Import an existing RestApi that can be configured with additional Methods and Resources.
* @experimental
*/
public static fromRestApiAttributes(scope: Construct, id: string, attrs: RestApiAttributes): IRestApi {
class Import extends RestApiBase {
Expand Down
3 changes: 0 additions & 3 deletions packages/@aws-cdk/aws-appsync/lib/graphqlapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,6 @@ export interface GraphqlApiProps {
*
* @default - schema will be generated code-first (i.e. addType, addObjectType, etc.)
*
* @experimental
*/
readonly schema?: Schema;
/**
Expand Down Expand Up @@ -583,7 +582,6 @@ export class GraphqlApi extends GraphqlApiBase {
* @param delimiter the delimiter between schema and addition
* @default - ''
*
* @experimental
*/
public addToSchema(addition: string, delimiter?: string): void {
this.schema.addToSchema(addition, delimiter);
Expand All @@ -594,7 +592,6 @@ export class GraphqlApi extends GraphqlApiBase {
*
* @param type the intermediate type to add to the schema
*
* @experimental
*/
public addType(type: IIntermediateType): IIntermediateType {
return this.schema.addType(type);
Expand Down
1 change: 0 additions & 1 deletion packages/@aws-cdk/aws-appsync/lib/schema-base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,6 @@ interface DirectiveOptions {
*
* i.e. @aws_iam or @aws_subscribe
*
* @experimental
*/
export class Directive {
/**
Expand Down
2 changes: 0 additions & 2 deletions packages/@aws-cdk/aws-appsync/lib/schema-field.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import { Type, IField, IIntermediateType, Directive } from './schema-base';
* @option isRequired - is this attribute non-nullable
* @option isRequiredList - is this attribute a non-nullable list
*
* @experimental
*/
export interface BaseTypeOptions {
/**
Expand Down Expand Up @@ -48,7 +47,6 @@ export interface BaseTypeOptions {
* @option isRequiredList - is this attribute a non-nullable list
* @option objectType - the object type linked to this attribute
*
* @experimental
*/
export interface GraphqlTypeOptions extends BaseTypeOptions {
/**
Expand Down
9 changes: 0 additions & 9 deletions packages/@aws-cdk/aws-appsync/lib/schema-intermediate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { BaseTypeOptions, GraphqlType, ResolvableFieldOptions, ResolvableField }
* i.e. { string: GraphqlType, string: GraphqlType }
* @param directives - the directives for this object type
*
* @experimental
*/
export interface IntermediateTypeOptions {
/**
Expand All @@ -31,7 +30,6 @@ export interface IntermediateTypeOptions {
* Interface Types are abstract types that includes a certain set of fields
* that other types must include if they implement the interface.
*
* @experimental
*/
export class InterfaceType implements IIntermediateType {
/**
Expand Down Expand Up @@ -122,7 +120,6 @@ export class InterfaceType implements IIntermediateType {
* @param interfaceTypes - the interfaces that this object type implements
* @param directives - the directives for this object type
*
* @experimental
*/
export interface ObjectTypeOptions extends IntermediateTypeOptions {
/**
Expand All @@ -136,7 +133,6 @@ export interface ObjectTypeOptions extends IntermediateTypeOptions {
/**
* Object Types are types declared by you.
*
* @experimental
*/
export class ObjectType extends InterfaceType implements IIntermediateType {
/**
Expand Down Expand Up @@ -233,7 +229,6 @@ export class ObjectType extends InterfaceType implements IIntermediateType {
* Input Types are abstract types that define complex objects.
* They are used in arguments to represent
*
* @experimental
*/
export class InputType implements IIntermediateType {
/**
Expand Down Expand Up @@ -309,7 +304,6 @@ export class InputType implements IIntermediateType {
/**
* Properties for configuring an Union Type
*
* @experimental
*/
export interface UnionTypeOptions {
/**
Expand All @@ -325,7 +319,6 @@ export interface UnionTypeOptions {
* Note that fields of a union type need to be object types. In other words,
* you can't create a union type out of interfaces, other unions, or inputs.
*
* @experimental
*/
export class UnionType implements IIntermediateType {
/**
Expand Down Expand Up @@ -405,7 +398,6 @@ export class UnionType implements IIntermediateType {
/**
* Properties for configuring an Enum Type
*
* @experimental
*/
export interface EnumTypeOptions {
/**
Expand All @@ -418,7 +410,6 @@ export interface EnumTypeOptions {
* Enum Types are abstract types that includes a set of fields
* that represent the strings this type can create.
*
* @experimental
*/
export class EnumType implements IIntermediateType {
/**
Expand Down
2 changes: 0 additions & 2 deletions packages/@aws-cdk/aws-appsync/lib/schema.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,6 @@ export class Schema {
* @param delimiter the delimiter between schema and addition
* @default - ''
*
* @experimental
*/
public addToSchema(addition: string, delimiter?: string): void {
if (this.mode !== SchemaMode.CODE) {
Expand Down Expand Up @@ -186,7 +185,6 @@ export class Schema {
*
* @param type the intermediate type to add to the schema
*
* @experimental
*/
public addType(type: IIntermediateType): IIntermediateType {
if (this.mode !== SchemaMode.CODE) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import { CertificateProps, ICertificate } from './certificate';
/**
* Properties to create a DNS validated certificate managed by AWS Certificate Manager
*
* @experimental
*/
export interface DnsValidatedCertificateProps extends CertificateProps {
/**
Expand Down Expand Up @@ -54,7 +53,6 @@ export interface DnsValidatedCertificateProps extends CertificateProps {
* validated using DNS validation against the specified Route 53 hosted zone.
*
* @resource AWS::CertificateManager::Certificate
* @experimental
*/
export class DnsValidatedCertificate extends cdk.Resource implements ICertificate, cdk.ITaggable {
public readonly certificateArn: string;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import { Construct } from 'constructs';

/**
* Properties for creating a Lambda@Edge function
* @experimental
*/
export interface EdgeFunctionProps extends lambda.FunctionProps {
/**
Expand All @@ -36,7 +35,6 @@ export interface EdgeFunctionProps extends lambda.FunctionProps {
* See https://docs.aws.amazon.com/cdk/latest/guide/bootstrapping.html or 'cdk bootstrap --help' for options.
*
* @resource AWS::Lambda::Function
* @experimental
*/
export class EdgeFunction extends Resource implements lambda.IVersion {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ export interface ServiceCatalogDeployActionBeta1Props extends codepipeline.Commo

/**
* CodePipeline action to connect to an existing ServiceCatalog product.
<<<<<<< HEAD:packages/@aws-cdk/aws-codepipeline-actions/lib/servicecatalog/deploy-action.ts
*
* **Note**: this class is still experimental, and may have breaking changes in the future!
*
=======
>>>>>>> master:packages/@aws-cdk/aws-codepipeline-actions/lib/servicecatalog/deploy-action-beta1.ts
*/
export class ServiceCatalogDeployActionBeta1 extends Action {
private readonly templatePath: string;
Expand Down
3 changes: 0 additions & 3 deletions packages/@aws-cdk/aws-codepipeline/lib/pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ export interface PipelineProps {
* the construct will automatically create a Stack containing an S3 Bucket in that region.
*
* @default - None.
* @experimental
*/
readonly crossRegionReplicationBuckets?: { [region: string]: s3.IBucket };

Expand Down Expand Up @@ -386,7 +385,6 @@ export class Pipeline extends PipelineBase {
* Returns all of the {@link CrossRegionSupportStack}s that were generated automatically
* when dealing with Actions that reside in a different region than the Pipeline itself.
*
* @experimental
*/
public get crossRegionSupport(): { [region: string]: CrossRegionSupport } {
const ret: { [region: string]: CrossRegionSupport } = {};
Expand Down Expand Up @@ -936,7 +934,6 @@ export class Pipeline extends PipelineBase {
* the cross-region capabilities of CodePipeline.
* You get instances of this interface from the {@link Pipeline#crossRegionSupport} property.
*
* @experimental
*/
export interface CrossRegionSupport {
/**
Expand Down
1 change: 0 additions & 1 deletion packages/@aws-cdk/aws-dynamodb/lib/table.ts
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,6 @@ export interface TableOptions {
* Regions where replica tables will be created
*
* @default - no replica tables are created
* @experimental
*/
readonly replicationRegions?: string[];

Expand Down
Loading

0 comments on commit 612f55b

Please sign in to comment.