Show / Hide Table of Contents

Class ResourceProps

Construction properties for Resource.

Inheritance
object
ResourceProps
Implements
IResourceProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ResourceProps : IResourceProps
Syntax (vb)
Public Class ResourceProps Implements IResourceProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            var resourceProps = new ResourceProps {
                Account = "account",
                EnvironmentFromArn = "environmentFromArn",
                PhysicalName = "physicalName",
                Region = "region"
            };

Synopsis

Constructors

ResourceProps()

Construction properties for Resource.

Properties

Account

The AWS account ID this resource belongs to.

EnvironmentFromArn

ARN to deduce region and account from.

PhysicalName

The value passed in by users to the physical name prop of the resource.

Region

The AWS region this resource belongs to.

Constructors

ResourceProps()

Construction properties for Resource.

public ResourceProps()
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;

            var resourceProps = new ResourceProps {
                Account = "account",
                EnvironmentFromArn = "environmentFromArn",
                PhysicalName = "physicalName",
                Region = "region"
            };

Properties

Account

The AWS account ID this resource belongs to.

public string? Account { get; set; }
Property Value

string

Remarks

Default: - the resource is in the same account as the stack it belongs to

EnvironmentFromArn

ARN to deduce region and account from.

public string? EnvironmentFromArn { get; set; }
Property Value

string

Remarks

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

Default: - take environment from account, region parameters, or use Stack environment.

PhysicalName

The value passed in by users to the physical name prop of the resource.

public string? PhysicalName { get; set; }
Property Value

string

Remarks

    Default: - The physical name will be allocated by CloudFormation at deployment time

    Region

    The AWS region this resource belongs to.

    public string? Region { get; set; }
    Property Value

    string

    Remarks

    Default: - the resource is in the same region as the stack it belongs to

    Implements

    IResourceProps
    Back to top Generated by DocFX