Class: AWSCDK::CliCredentialsStackSynthesizerProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cli_credentials_stack_synthesizer_props.rb

Overview

Properties for the CliCredentialsStackSynthesizer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_prefix: nil, docker_tag_prefix: nil, file_assets_bucket_name: nil, image_assets_repository_name: nil, qualifier: nil) ⇒ CliCredentialsStackSynthesizerProps

Returns a new instance of CliCredentialsStackSynthesizerProps.

Parameters:

  • bucket_prefix (String, nil) (defaults to: nil) —

    bucketPrefix to use while storing S3 Assets.

  • docker_tag_prefix (String, nil) (defaults to: nil) —

    A prefix to use while tagging and uploading Docker images to ECR.

  • file_assets_bucket_name (String, nil) (defaults to: nil) —

    Name of the S3 bucket to hold file assets.

  • image_assets_repository_name (String, nil) (defaults to: nil) —

    Name of the ECR repository to hold Docker Image assets.

  • qualifier (String, nil) (defaults to: nil) —

    Qualifier to disambiguate multiple environments in the same account.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 12

def initialize(bucket_prefix: nil, docker_tag_prefix: nil, file_assets_bucket_name: nil, image_assets_repository_name: nil, qualifier: nil)
  @bucket_prefix = bucket_prefix
  Jsii::Type.check_type(@bucket_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketPrefix") unless @bucket_prefix.nil?
  @docker_tag_prefix = docker_tag_prefix
  Jsii::Type.check_type(@docker_tag_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dockerTagPrefix") unless @docker_tag_prefix.nil?
  @file_assets_bucket_name = file_assets_bucket_name
  Jsii::Type.check_type(@file_assets_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fileAssetsBucketName") unless @file_assets_bucket_name.nil?
  @image_assets_repository_name = image_assets_repository_name
  Jsii::Type.check_type(@image_assets_repository_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageAssetsRepositoryName") unless @image_assets_repository_name.nil?
  @qualifier = qualifier
  Jsii::Type.check_type(@qualifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "qualifier") unless @qualifier.nil?
end

Instance Attribute Details

#bucket_prefix ⇒ String? (readonly)

Note:

Default: - DefaultStackSynthesizer.DEFAULT_FILE_ASSET_PREFIX

bucketPrefix to use while storing S3 Assets.

Returns:

  • (String, nil) 


29
30
31
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 29

def bucket_prefix
  @bucket_prefix
end

#docker_tag_prefix ⇒ String? (readonly)

Note:

Default: - DefaultStackSynthesizer.DEFAULT_DOCKER_ASSET_PREFIX

A prefix to use while tagging and uploading Docker images to ECR.

This does not add any separators - the source hash will be appended to this string directly.

Returns:

  • (String, nil) 


37
38
39
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 37

def docker_tag_prefix
  @docker_tag_prefix
end

#file_assets_bucket_name ⇒ String? (readonly)

Note:

Default: DefaultStackSynthesizer.DEFAULT_FILE_ASSETS_BUCKET_NAME

Name of the S3 bucket to hold file assets.

You must supply this if you have given a non-standard name to the staging bucket.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Returns:

  • (String, nil) 


48
49
50
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 48

def file_assets_bucket_name
  @file_assets_bucket_name
end

#image_assets_repository_name ⇒ String? (readonly)

Note:

Default: DefaultStackSynthesizer.DEFAULT_IMAGE_ASSETS_REPOSITORY_NAME

Name of the ECR repository to hold Docker Image assets.

You must supply this if you have given a non-standard name to the ECR repository.

The placeholders ${Qualifier}, ${AWS::AccountId} and ${AWS::Region} will be replaced with the values of qualifier and the stack's account and region, respectively.

Returns:

  • (String, nil) 


59
60
61
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 59

def image_assets_repository_name
  @image_assets_repository_name
end

#qualifier ⇒ String? (readonly)

Note:

Default: - Value of context key '@aws-cdk/core:bootstrapQualifier' if set, otherwise DefaultStackSynthesizer.DEFAULT_QUALIFIER

Qualifier to disambiguate multiple environments in the same account.

You can use this and leave the other naming properties empty if you have deployed the bootstrap environment with standard names but only different qualifiers.

Returns:

  • (String, nil) 


67
68
69
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 67

def qualifier
  @qualifier
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 69

def self.jsii_properties
  {
    :bucket_prefix => "bucketPrefix",
    :docker_tag_prefix => "dockerTagPrefix",
    :file_assets_bucket_name => "fileAssetsBucketName",
    :image_assets_repository_name => "imageAssetsRepositoryName",
    :qualifier => "qualifier",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
 
# File 'cli_credentials_stack_synthesizer_props.rb', line 79

def to_jsii
  result = {}
  result.merge!({
    "bucketPrefix" => @bucket_prefix,
    "dockerTagPrefix" => @docker_tag_prefix,
    "fileAssetsBucketName" => @file_assets_bucket_name,
    "imageAssetsRepositoryName" => @image_assets_repository_name,
    "qualifier" => @qualifier,
  })
  result.compact
end