@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:45.646Z")
public interface CfnImageBuilderProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appstream.*; CfnImageBuilderProps cfnImageBuilderProps = CfnImageBuilderProps.builder() .instanceType("instanceType") .name("name") // the properties below are optional .accessEndpoints(List.of(AccessEndpointProperty.builder() .endpointType("endpointType") .vpceId("vpceId") .build())) .appstreamAgentVersion("appstreamAgentVersion") .description("description") .displayName("displayName") .domainJoinInfo(DomainJoinInfoProperty.builder() .directoryName("directoryName") .organizationalUnitDistinguishedName("organizationalUnitDistinguishedName") .build()) .enableDefaultInternetAccess(false) .iamRoleArn("iamRoleArn") .imageArn("imageArn") .imageName("imageName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .vpcConfig(VpcConfigProperty.builder() .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
CfnImageBuilderProps.Builder
A builder for
CfnImageBuilderProps |
static class |
CfnImageBuilderProps.Jsii$Proxy
An implementation for
CfnImageBuilderProps |
Modifier and Type | Method and Description |
---|---|
static CfnImageBuilderProps.Builder |
builder() |
default java.lang.Object |
getAccessEndpoints()
The list of virtual private cloud (VPC) interface endpoint objects.
|
default java.lang.String |
getAppstreamAgentVersion()
The version of the AppStream 2.0 agent to use for this image builder.
|
default java.lang.String |
getDescription()
The description to display.
|
default java.lang.String |
getDisplayName()
The image builder name to display.
|
default java.lang.Object |
getDomainJoinInfo()
The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
|
default java.lang.Object |
getEnableDefaultInternetAccess()
Enables or disables default internet access for the image builder.
|
default java.lang.String |
getIamRoleArn()
The ARN of the IAM role that is applied to the image builder.
|
default java.lang.String |
getImageArn()
The ARN of the public, private, or shared image to use.
|
default java.lang.String |
getImageName()
The name of the image used to create the image builder.
|
java.lang.String |
getInstanceType()
The instance type to use when launching the image builder.
|
java.lang.String |
getName()
A unique name for the image builder.
|
default java.util.List<CfnTag> |
getTags()
An array of key-value pairs.
|
default java.lang.Object |
getVpcConfig()
The VPC configuration for the image builder.
|
java.lang.String getInstanceType()
java.lang.String getName()
default java.lang.Object getAccessEndpoints()
Administrators can connect to the image builder only through the specified endpoints.
default java.lang.String getAppstreamAgentVersion()
default java.lang.String getDescription()
default java.lang.String getDisplayName()
default java.lang.Object getDomainJoinInfo()
default java.lang.Object getEnableDefaultInternetAccess()
default java.lang.String getIamRoleArn()
To assume a role, the image builder calls the AWS Security Token Service AssumeRole
API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance.
For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide .
default java.lang.String getImageArn()
default java.lang.String getImageName()
default java.util.List<CfnTag> getTags()
default java.lang.Object getVpcConfig()
You can specify only one subnet.
static CfnImageBuilderProps.Builder builder()
CfnImageBuilderProps.Builder
of CfnImageBuilderProps