Class: AWSCDK::Autoscaling::CfnAutoScalingGroup::TrafficSourceIdentifierProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
autoscaling/cfn_auto_scaling_group.rb

Overview

Identifying information for a traffic source.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identifier:, type:) ⇒ TrafficSourceIdentifierProperty

Returns a new instance of TrafficSourceIdentifierProperty.

Parameters:

  • identifier (String)

    Identifies the traffic source.

  • type (String)

    Provides additional context for the value of Identifier .



2908
2909
2910
2911
2912
2913
# File 'autoscaling/cfn_auto_scaling_group.rb', line 2908

def initialize(identifier:, type:)
  @identifier = identifier
  Jsii::Type.check_type(@identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identifier")
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
end

Instance Attribute Details

#identifierString (readonly)

Identifies the traffic source.

For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.

For example:

  • Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
  • Classic Load Balancer name: my-classic-load-balancer
  • VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456

To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.

To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.



2931
2932
2933
# File 'autoscaling/cfn_auto_scaling_group.rb', line 2931

def identifier
  @identifier
end

#typeString (readonly)

Provides additional context for the value of Identifier .

The following lists the valid values:

  • elb if Identifier is the name of a Classic Load Balancer.
  • elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.
  • vpc-lattice if Identifier is the ARN of a VPC Lattice target group.

Required if the identifier is the name of a Classic Load Balancer.



2944
2945
2946
# File 'autoscaling/cfn_auto_scaling_group.rb', line 2944

def type
  @type
end

Class Method Details

.jsii_propertiesObject



2946
2947
2948
2949
2950
2951
# File 'autoscaling/cfn_auto_scaling_group.rb', line 2946

def self.jsii_properties
  {
    :identifier => "identifier",
    :type => "type",
  }
end

Instance Method Details

#to_jsiiObject



2953
2954
2955
2956
2957
2958
2959
2960
# File 'autoscaling/cfn_auto_scaling_group.rb', line 2953

def to_jsii
  result = {}
  result.merge!({
    "identifier" => @identifier,
    "type" => @type,
  })
  result.compact
end