Bases: CfnResource
(deprecated) A CloudFormation AWS::ApiGatewayV2::DomainName.
moved to package aws-apigatewayv2
deprecated
AWS::ApiGatewayV2::DomainName
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway
# tags: Any
cfn_domain_name_v2 = apigateway.CfnDomainNameV2(self, "MyCfnDomainNameV2",
domain_name="domainName",
# the properties below are optional
domain_name_configurations=[apigateway.CfnDomainNameV2.DomainNameConfigurationProperty(
certificate_arn="certificateArn",
certificate_name="certificateName",
endpoint_type="endpointType"
)],
tags=tags
)
(deprecated) Create a new AWS::ApiGatewayV2::DomainName.
scope (Construct) â
scope in which this resource is defined.
id (str) â
scoped id of the resource.
domain_name (str) â (deprecated) AWS::ApiGatewayV2::DomainName.DomainName.
domain_name_configurations (Union[IResolvable, Sequence[Union[IResolvable, DomainNameConfigurationProperty, Dict[str, Any]]], None]) â (deprecated) AWS::ApiGatewayV2::DomainName.DomainNameConfigurations.
tags (Optional[Any]) â (deprecated) AWS::ApiGatewayV2::DomainName.Tags.
deprecated
Methods
Syntactic sugar for addOverride(path, undefined).
path (str) â The path of the value to delete.
None
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
target (CfnResource)
None
Add a value to the CloudFormation Resource Metadata.
key (str)
value (Any)
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use addPropertyOverride or prefix path with âProperties.â (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
path (str) â
The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (Any) â
The value. Could be primitive or complex.
None
Adds an override that deletes the value of a property from the resource definition.
property_path (str) â The path to the property.
None
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
property_path (str) â The path of the property.
value (Any) â The value.
None
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because youâve removed it from the CDK application or because youâve made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) â Apply the same deletion policy to the resourceâs âUpdateReplacePolicyâ. Default: true
default (Optional[RemovalPolicy]) â The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resourceâs documentation.
None
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
attribute_name (str) â The name of the attribute.
Retrieve a value value from the CloudFormation Resource Metadata.
key (str)
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
(deprecated) Examines the CloudFormation resource and discloses attributes.
inspector (TreeInspector) â
tree inspector to collect and process attributes.
deprecated
None
Overrides the auto-generated logical ID with a specific ID.
new_logical_id (str) â The new logical ID to use for this stack element.
None
Returns a string representation of this construct.
str
a string representation of this resource
Attributes
deprecated :cloudformationAttribute: RegionalDomainName
stability
deprecated :cloudformationAttribute: RegionalHostedZoneId
stability
Options for this resource, such as condition, update policy etc.
AWS resource type.
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
(deprecated) AWS::ApiGatewayV2::DomainName.DomainName.
(deprecated) AWS::ApiGatewayV2::DomainName.DomainNameConfigurations.
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
the logical ID as a stringified token. This value will only get resolved during synthesis.
The construct tree node associated with this construct.
Return a string that will be resolved to a CloudFormation { Ref } for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
(deprecated) AWS::ApiGatewayV2::DomainName.Tags.
Static Methods
Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
x (Any)
bool
The construct as a stack element or undefined if it is not a stack element.
Check whether the given construct is a CfnResource.
construct (IConstruct)
bool
Return whether the given object is a Construct.
x (Any)
bool
Bases: object
certificate_arn (Optional[str]) â (deprecated) CfnDomainNameV2.DomainNameConfigurationProperty.CertificateArn.
certificate_name (Optional[str]) â (deprecated) CfnDomainNameV2.DomainNameConfigurationProperty.CertificateName.
endpoint_type (Optional[str]) â (deprecated) CfnDomainNameV2.DomainNameConfigurationProperty.EndpointType.
moved to package aws-apigatewayv2
deprecated
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway
domain_name_configuration_property = apigateway.CfnDomainNameV2.DomainNameConfigurationProperty(
certificate_arn="certificateArn",
certificate_name="certificateName",
endpoint_type="endpointType"
)
Attributes
(deprecated) CfnDomainNameV2.DomainNameConfigurationProperty.CertificateArn.
(deprecated) CfnDomainNameV2.DomainNameConfigurationProperty.CertificateName.
(deprecated) CfnDomainNameV2.DomainNameConfigurationProperty.EndpointType.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4