Class CfnAssetProps

Properties for defining a CfnAsset.

Inheritance

object

CfnAssetProps

Implements

ICfnAssetProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.DevOpsAgent

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAssetProps : ICfnAssetProps

Syntax (vb)

Public Class CfnAssetProps Implements ICfnAssetProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html

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.AWS.DevOpsAgent;

             var metadata;

             var cfnAssetProps = new CfnAssetProps {
                 AgentSpaceId = "agentSpaceId",
                 AssetType = "assetType",

                 // the properties below are optional
                 Files = new [] { new AssetFileProperty {
                     Path = "path",

                     // the properties below are optional
                     ContentBytes = "contentBytes",
                     ContentText = "contentText",
                     Metadata = metadata
                 } },
                 Metadata = metadata,
                 Zip = "zip"
             };

Synopsis

Constructors

CfnAssetProps()

Properties for defining a CfnAsset.

Properties

AgentSpaceId	The unique identifier of the parent Agent Space.
AssetType	The type of asset.
Files	Inline file list.
Metadata	Asset metadata document.
Zip	Base64-encoded zip bundle containing all files for the asset.

Constructors

CfnAssetProps()

Properties for defining a CfnAsset.

public CfnAssetProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html

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.AWS.DevOpsAgent;

             var metadata;

             var cfnAssetProps = new CfnAssetProps {
                 AgentSpaceId = "agentSpaceId",
                 AssetType = "assetType",

                 // the properties below are optional
                 Files = new [] { new AssetFileProperty {
                     Path = "path",

                     // the properties below are optional
                     ContentBytes = "contentBytes",
                     ContentText = "contentText",
                     Metadata = metadata
                 } },
                 Metadata = metadata,
                 Zip = "zip"
             };

Properties

AgentSpaceId

The unique identifier of the parent Agent Space.

public string AgentSpaceId { get; set; }

Property Value

string

Remarks

The asset is created as a child of this agent space.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html#cfn-devopsagent-asset-agentspaceid

AssetType

The type of asset.

public string AssetType { get; set; }

Property Value

string

Remarks

The Asset API treats this as an open string; call ListAssetTypes for the current authoritative set of supported types. As of launch, customer-creatable types include skill, agents_md, and attachment.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html#cfn-devopsagent-asset-assettype

Files

Inline file list.

public object? Files { get; set; }

Property Value

object

Remarks

Mutually exclusive with Zip; enforced by the handler at Create/Update time. Write-only: not repopulated by Read.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html#cfn-devopsagent-asset-files

Type union: either IResolvable or (either IResolvable or CfnAsset.IAssetFileProperty)[]

Metadata

Asset metadata document.

public object? Metadata { get; set; }

Property Value

object

Remarks

Required and optional keys depend on AssetType. Values may be strings, numbers, booleans, or lists of any of those - validated server-side; see the public Asset API docs for the per-type metadata schema.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html#cfn-devopsagent-asset-metadata

Zip

Base64-encoded zip bundle containing all files for the asset.

public string? Zip { get; set; }

Property Value

string

Remarks

Mutually exclusive with Files; enforced by the handler at Create/Update time. Write-only: not repopulated by Read. Server treats a zip as 'replace all files' (max 6 MiB).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-devopsagent-asset.html#cfn-devopsagent-asset-zip

Implements

ICfnAssetProps