Udostępnij za pośrednictwem


IStackResource Interface

Definition

Resource representing an AWS CDK stack.

public interface IStackResource : Aspire.Hosting.ApplicationModel.IResource, Aspire.Hosting.AWS.CDK.IResourceWithConstruct, Aspire.Hosting.AWS.CloudFormation.ICloudFormationTemplateResource
type IStackResource = interface
    interface ICloudFormationTemplateResource
    interface ICloudFormationResource
    interface IAWSResource
    interface IResource
    interface IResourceWithConstruct
Public Interface IStackResource
Implements ICloudFormationTemplateResource, IResource, IResourceWithConstruct
Derived
Implements

Properties

Annotations

Gets the annotations associated with the resource.

(Inherited from IResource)
AWSSDKConfig

Configuration for creating service clients from the AWS .NET SDK.

(Inherited from IAWSResource)
CloudFormationClient

The configured Amazon CloudFormation service client used to make service calls. If this property set then AWSSDKConfig is ignored.

(Inherited from ICloudFormationResource)
Construct

The AWS CDK construct

(Inherited from IResourceWithConstruct)
DisabledCapabilities

By default CloudFormation provisioning is given the CAPABILITY_IAM, CAPABILITY_NAMED_IAM and CAPABILITY_AUTO_EXPAND capabilities. To disable any or all of these capabilities add the these names to this collection.

(Inherited from ICloudFormationTemplateResource)
DisableDiffCheck

By default provisioning checks if the template and parameters haven't changed since the last provisioning. If they haven't changed then provisioning is skipped. Setting this property to true disables the check and always attempt provisioning.

(Inherited from ICloudFormationTemplateResource)
Name

Gets the name of the resource.

(Inherited from IResource)
Outputs

The output parameters of the CloudFormation stack.

(Inherited from ICloudFormationResource)
ProvisioningTaskCompletionSource

Set by the AWSProvisioner to indicate the task that is provisioning the resource.

(Inherited from IAWSResource)
RoleArn

The optional IAM role assumed by CloudFormation when creating or updating the Stack.

(Inherited from ICloudFormationTemplateResource)
Stack

The AWS CDK stack

StackName

The name of the Amazon CloudFormation stack

(Inherited from ICloudFormationResource)
StackPollingInterval

The interval in seconds to poll CloudFormation for changes. The default is 3 seconds. This value can be increased to avoid throttling errors polling CloudFormation.

(Inherited from ICloudFormationTemplateResource)
TemplatePath

Path to the CloudFormation template.

(Inherited from ICloudFormationTemplateResource)

Methods

AddParameter(String, String)

Add parameters to be provided to CloudFormation when creating the stack for the template.

(Inherited from ICloudFormationTemplateResource)

Extension Methods

GetReplicaCount(IResource)

Gets the number of replicas for the specified resource. Defaults to 1 if no ReplicaAnnotation is found.

TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)

Attempts to retrieve all annotations of the specified type from the given resource including from parents.

TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)

Attempts to retrieve all annotations of the specified type from the given resource.

TryGetContainerImageName(IResource, String)

Attempts to get the container image name from the given resource.

TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)

Attempts to get the container mounts for the specified resource.

TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)

Attempts to retrieve the endpoints for the given resource.

TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)

Attempts to get the environment variables from the given resource.

TryGetLastAnnotation<T>(IResource, T)

Attempts to get the last annotation of the specified type from the resource.

IsContainer(IResource)

Determines whether the specified resource is a container resource.

Applies to